Skip to content

Bp docs language tweaks#369

Open
codingfrog27 wants to merge 4 commits intomainfrom
BP-docs-language-tweaks
Open

Bp docs language tweaks#369
codingfrog27 wants to merge 4 commits intomainfrom
BP-docs-language-tweaks

Conversation

@codingfrog27
Copy link
Contributor

@codingfrog27 codingfrog27 commented Mar 11, 2026

EDIT: Second pass

  • merged why to pick and what you can do into 1 use case section for more consiseness
    • conceptual features are now in expanded intro
  • restructered how it works section and included graphic
    • This could potentially be it’s own page
  • Pushed future support into its own roadmap section
    • Beware maintenance cost (though This was already present and if anything should be easier to maintain now)

I’ve also reworded the entire thing to be more consise, and hopefully add more clarity. (Ie: before we led with each pod being ephemeral, but we should be clear that our filesystem is still consistent)

Not sure if this was overkill so for the time being Ive also committed a more “fluffy” alternative overview

-----First PR notes Below here -----

Another pass at the BP docs. Still due from our 1.0 release. To bring the language and direction a bit more in line with our release blog post etc.

Changes:

  • FAQ: Added questions covering untrusted code execution, cloud sandbox comparisons, data security, performance, and Portals
  • Portals docs: Added "What Portals enable" section with concrete use cases (live previews, collaborative workflows, cross-device testing)
  • Glossary: Enhanced definitions for Portal, Pod, and BrowserPod API with more technical detail
    Getting started: Minor intro improvements for clarity

Copy link
Contributor

@GabrielaReyna GabrielaReyna left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Overall looks good to me. I would only advice to not abuse the use of bullet points in the overview page. Almost all sections are entirely bullet points, and the lists are long and difficult to read.

I left comments on two of the subsections with potential solutions.

- **Enable education at scale**: Provide high-fidelity learning environments with minimal operational overhead. Eliminate per-student sandbox costs to make hands-on education economically feasible at scale.
- **Process sensitive data locally**: Keep user inputs and outputs in the browser by default, enabling privacy-first applications and removing jurisdictional risks associated with cloud data transfer.

## Why pick the BrowserPod API?
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This section's bullet points can be re-shaped by using subheadings (###) instead of the list. An idea is to group similar topics into one subheading and make the content one to two short paragraphs.

For example, latency and portals could be a single subtopic (name it as you feel it) given both talk about no network trips and meeting the user where they are. Economics its a substantial topic already. Security is another substancial subtopic. Etc.

- **Multi-language by design**: BrowserPod is architected from the ground up as a language-agnostic execution platform. While it launches with Node.js, its Linux-compliant foundation supports any runtime—Python, Ruby, Go, Rust, and eventually full Linux containers—rather than being constrained to a single ecosystem.
- **Portals**: Share working applications instantly via secure, temporary URLs. Enable live previews, collaborative troubleshooting, and interactive demos without standing up dedicated infrastructure.

## How it works (high level)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This section is also hard to follow as un-numbered bullet points list.

We have two options here:

  • Make the bullet points a numbered list, where you explain the user the step by step of how browserpod works and how the different parts connect to each other. The numers help the user follow a sequence. It is hard to tell if you are using the bulletpoints as a sequence, or as separate components of the browserpod architecture.
  • Make it plain text (2-3 short paragraps) where you tell the story of how it works.

I can also see adding the technical graphic, here or on a more detailed page of how browserpod works.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am talking about the graphic in this post: https://labs.leaningtech.com/blog/browserpod-10

@cloudflare-workers-and-pages
Copy link

cloudflare-workers-and-pages bot commented Mar 19, 2026

Deploying labs-browserpod-previews with  Cloudflare Pages  Cloudflare Pages

Latest commit: 284e095
Status: ✅  Deploy successful!
Preview URL: https://98c3c1d0.labs-browserpod-previews.pages.dev
Branch Preview URL: https://bp-docs-language-tweaks.labs-browserpod-previews.pages.dev

View logs

@codingfrog27 codingfrog27 force-pushed the BP-docs-language-tweaks branch from c5999b5 to 284e095 Compare March 19, 2026 14:30
Copy link
Contributor

@GabrielaReyna GabrielaReyna left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good job, just minor suggested edits and should be good to go.


All the major browsers on desktop and mobile (Chrome, Edge, Firefox, Safari) are supported.

## Is BrowserPod good for running untrusted code?
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
## Is BrowserPod good for running untrusted code?
## Why is BrowserPod good for running untrusted code?


## Is BrowserPod good for running untrusted code?

Yes. BrowserPod is designed for executing code in a sandboxed environment, whether that's user-provided scripts, AI-generated code, or dynamically loaded modules. It provides strong isolation through the browser's security sandbox, keeping execution local to the user's device while maintaining high fidelity with native environments.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Yes. BrowserPod is designed for executing code in a sandboxed environment, whether that's user-provided scripts, AI-generated code, or dynamically loaded modules. It provides strong isolation through the browser's security sandbox, keeping execution local to the user's device while maintaining high fidelity with native environments.
BrowserPod is designed for executing code in a sandboxed environment, whether that's user-provided scripts, AI-generated code, or dynamically loaded modules. It provides strong isolation through the browser's security sandbox, keeping execution local to the user's device while maintaining high fidelity with native environments.

1. **Modular Engines:** BrowserPod loads a language engine (e.g., Node.js) compiled to Wasm. These are not shims; they are full runtimes that interact with a virtualized Linux kernel interface.
2. **Stateless Compute, Persistent Data:** While the **compute** session is ephemeral (tied to the lifecycle of the browser tab), the **filesystem** is persistent. Disk state is provided via block-based streaming; changes are stored locally and can be rehydrated across sessions.
3. **True Concurrency:** Using WebWorkers, BrowserPod supports real process isolation and multi-threading, enabling modern build pipelines and complex toolchains to run without modification.
4. **Instant Networking:** Through **Portals**, any service listening on a port inside the pod is instantly accessible via a shareable, secure URL, handled entirely on the client side.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
4. **Instant Networking:** Through **Portals**, any service listening on a port inside the pod is instantly accessible via a shareable, secure URL, handled entirely on the client side.
4. **Instant Networking:** Through [**_Portals_**](/docs/understanding-browserpod/portals), any service listening on a port inside the pod is instantly accessible via a shareable, secure URL, handled entirely on the client side.

@@ -0,0 +1,80 @@
---
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I like this overview better

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants